Skip to content

chore: Moved orphaned doxygen block back to declaration#1701

Open
jvarCS wants to merge 1 commit into
hiero-ledger:mainfrom
jvarCS:orphanedDoxygen
Open

chore: Moved orphaned doxygen block back to declaration#1701
jvarCS wants to merge 1 commit into
hiero-ledger:mainfrom
jvarCS:orphanedDoxygen

Conversation

@jvarCS

@jvarCS jvarCS commented Jul 24, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description:
Moved orphaned doxygen block above ==operator declaration and removed the hanging doxygen block.

Related issue(s):

Fixes #1613

Notes for reviewer:
Image shows doxygen block now above the operator declaration
image

Image shows deleted hanging doxygen block
image

Summary by CodeRabbit

  • Documentation
    • Improved the placement of comparison-operator documentation for clearer API reference navigation.
    • No functional behavior or public API changes.

@jvarCS
chore: moved orphaned doxygen block back to declaration
1c00a6a 
Signed-off-by: jvarCS <vargassegoviano@gmail.com>
@jvarCS
jvarCS requested review from a team as code owners July 24, 2026 02:20
@jvarCS
jvarCS requested a review from rwalworth July 24, 2026 02:20
@github-actions

github-actions Bot commented Jul 24, 2026

Copy link
Copy Markdown

Hey @jvarCS 👋 thanks for the PR!
I'm your friendly PR Helper Bot 🤖 and I'll be riding shotgun on this one, keeping track of your PR's status to help you get it approved and merged.

This comment updates automatically as you push changes -- think of it as your PR's live scoreboard!
Here's the latest:

PR Checks

✅ DCO Sign-off -- All commits have valid sign-offs. Nice work!

✅ GPG Signature -- All commits have verified GPG signatures. Locked and loaded!

✅ Merge Conflicts -- No merge conflicts detected. Smooth sailing!

✅ Issue Link -- Linked to #1613 (assigned to you).

🎉 All checks passed! Your PR is ready for review. Great job!

@github-actions github-actions Bot added the status: needs review The pull request is ready for maintainer review label Jul 24, 2026
@coderabbitai

coderabbitai Bot commented Jul 24, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The Doxygen block for FeeComponents::operator== is moved immediately before the public declaration, and the orphaned block is removed from its previous location. No functional code or signature changes are made.

Changes

FeeComponents documentation

Layer / File(s) Summary
Relocate operator== documentation
src/sdk/main/include/FeeComponents.h		 Moves the equality operator’s Doxygen comment next to its declaration and removes the previous orphaned placement.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: rwalworth

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The change matches #1613 by moving the orphaned operator== Doxygen block to its declaration and removing the orphaned copy.
Out of Scope Changes check ✅ Passed The PR stays within scope with a single-file header comment move and no functional or unrelated code changes.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: moving the orphaned Doxygen block back above the operator declaration.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rwalworth rwalworth Awaiting requested review from rwalworth rwalworth is a code owner automatically assigned from hiero-ledger/hiero-sdk-cpp-maintainers

At least 1 approving review is required to merge this pull request.

Assignees

@jvarCS jvarCS

Labels

status: needs review The pull request is ready for maintainer review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Good First Issue]: Move orphaned operator== Doxygen block to the public declaration in FeeComponents.h

1 participant

@jvarCS